home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audio / alNewEvent.z / alNewEvent
Encoding:
Text File  |  2002-10-03  |  4.4 KB  |  67 lines
  1.  
  2.  
  3.  
  4. aaaallllNNNNeeeewwwwEEEEvvvveeeennnntttt((((3333ddddmmmm))))                                                aaaallllNNNNeeeewwwwEEEEvvvveeeennnntttt((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alNewEvent - create and initialize an audio AAAALLLLeeeevvvveeeennnntttt structure
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  13.  
  14.      AAAALLLLeeeevvvveeeennnntttt aaaallllNNNNeeeewwwwEEEEvvvveeeennnntttt((((vvvvooooiiiidddd))))
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      aaaallllNNNNeeeewwwwEEEEvvvveeeennnntttt creates and initializes an AAAALLLLeeeevvvveeeennnntttt structure.  An AAAALLLLeeeevvvveeeennnntttt
  18.      structure contains the event information of a particular audio system
  19.      change.  Events are retrieved from event queues through aaaallllNNNNeeeexxxxttttEEEEvvvveeeennnntttt((((3333ddddmmmm))))
  20.      and aaaallllCCCChhhheeeecccckkkkEEEEvvvveeeennnntttt((((3333ddddmmmm)))).  All events have an audio parameter associated
  21.      with them.  For example, an ALevent with an AL_RATE parameter means that
  22.      an AL_RATE change occurred on an audio resource. Please refer to
  23.      aaaallllPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) for more information.
  24.  
  25.      To access event information, use the following calls:
  26.      aaaallllEEEEvvvveeeennnnttttGGGGeeeettttSSSSrrrrccccRRRReeeessssoooouuuurrrrcccceeee((((3333ddddmmmm)))), aaaallllEEEEvvvveeeennnnttttGGGGeeeettttRRRReeeessssoooouuuurrrrcccceeee((((3333ddddmmmm)))), aaaallllGGGGeeeettttEEEEvvvveeeennnnttttUUUUSSSSTTTT((((3333ddddmmmm)))),
  27.      aaaallllGGGGeeeettttEEEEvvvveeeennnnttttDDDDaaaattttaaaa((((3333ddddmmmm)))), aaaallllGGGGeeeettttEEEEvvvveeeennnnttttPPPPaaaarrrraaaammmm((((3333ddddmmmm)))), and aaaallllGGGGeeeettttEEEEvvvveeeennnnttttVVVVaaaalllluuuueeee((((3333ddddmmmm)))).
  28.      Some non-scalar parameters require a call to aaaallllGGGGeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) in order to
  29.      access the event data information.  Refer to aaaallllPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) for more
  30.      information on the specific parameters and their methods for retrieving
  31.      data from an AAAALLLLeeeevvvveeeennnntttt.
  32.  
  33. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  34.      Upon successful completion, aaaallllNNNNeeeewwwwEEEEvvvveeeennnntttt returns an opaque AAAALLLLeeeevvvveeeennnntttt
  35.      structure with all its members initialized to zero. If the structure
  36.      allocation fails, aaaallllNNNNeeeewwwwEEEEvvvveeeennnntttt returns 0 and sets an error number which can
  37.      be retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  38.  
  39.      aaaallllNNNNeeeewwwwEEEEvvvveeeennnntttt can fail for the following reason:
  40.  
  41.      AAAALLLL____BBBBAAAADDDD____OOOOUUUUTTTT____OOOOFFFF____MMMMEEEEMMMM   insufficient memory is available to allocate the
  42.                          AAAALLLLeeeevvvveeeennnntttt structure.
  43.  
  44. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  45.      alFreeEvent(3dm), AlGetEventParam(3dm), alGetEventResorce(3dm),
  46.      alGetEventSrcResource(3dm), alGetEventUST(3dm), alGetEventValue(3dm),
  47.      alGetEventData(3dm), alParams(3dm), oserror(3C)
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.